chore: upgrade to markdownlint v0.39.0 #3200
Conversation
rootulp
requested review from
liamsi,
adlerjohn,
evan-forbes,
cmwaters,
staheri14 and
ninabarbakadze
as code owners
WalkthroughWalkthroughThe overall change focuses on enhancing the Markdown linting setup and documentation formatting within a project. It updates the Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
|
||
| Cosmos Hub (a.k.a Gaia) sets `BlocksPerYear` to 4,360,000 [here](https://github.com/cosmos/gaia/blob/8a522e98a2863205cf02fb97f8ad27d091670b9d/docs/governance/current-parameters.json#L86). Cosmos Hub has a block time 6.353 ms. Numia data doesn't have complete data for 2021 so we'll examine 2022: | ||
|
|
||
| Year | BlocksPerYear | Actual # of Blocks | Skew | ||
| -----|---------------|--------------------|------ | ||
| 2022 | 4,360,000 | 4,580,463 | 5.05% | ||
| | Year | BlocksPerYear | Actual # of Blocks | Skew | | ||
| |------|---------------|--------------------|-------| | ||
| | 2022 | 4,360,000 | 4,580,463 | 5.05% | | ||
|
|
||
| Source: [Numia query](https://console.cloud.google.com/bigquery?sq=611612269782:f0c42f9584c448c78a4ec5f118c2091c) |
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [100-100]
The verb "trigger" should agree with its subject, suggesting a revision to "triggers". For example: "...when a validator or delegator triggers a withdrawal..."
- At some point in the future when a validator or delegator trigger a withdrawal, tokens are withdrawn from...
+ At some point in the future when a validator or delegator triggers a withdrawal, tokens are withdrawn from...| | Blob size (in number of shares) | Subtree root width[^2] | Index in square | Worst case padding | | ||
| |---------------------------------|------------------------|-----------------|--------------------| | ||
| | blob <= 64 | 1 | multiple of 1 | 0 | | ||
| | 64 < blob <= 128 | 2 | multiple of 2 | 1 | | ||
| | 128 < blob <= 256 | 4 | multiple of 4 | 3 | | ||
| | 256 < blob <= 512 | 8 | multiple of 8 | 7 | |
There was a problem hiding this comment.
The table formatting changes improve readability and consistency. However, consider adding a header row to enhance clarity further.
+ | Blob size range | Subtree root width | Index multiple | Worst-case padding |
|---------------------------------|------------------------|-----------------|--------------------|
| blob <= 64 | 1 | multiple of 1 | 0 |
| 64 < blob <= 128 | 2 | multiple of 2 | 1 |
| 128 < blob <= 256 | 4 | multiple of 4 | 3 |
| 256 < blob <= 512 | 8 | multiple of 8 | 7 |Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| | Blob size (in number of shares) | Subtree root width[^2] | Index in square | Worst case padding | | |
| |---------------------------------|------------------------|-----------------|--------------------| | |
| | blob <= 64 | 1 | multiple of 1 | 0 | | |
| | 64 < blob <= 128 | 2 | multiple of 2 | 1 | | |
| | 128 < blob <= 256 | 4 | multiple of 4 | 3 | | |
| | 256 < blob <= 512 | 8 | multiple of 8 | 7 | | |
| | Blob size range | Subtree root width | Index multiple | Worst-case padding | | |
| |---------------------------------|------------------------|-----------------|--------------------| | |
| | blob <= 64 | 1 | multiple of 1 | 0 | | |
| | 64 < blob <= 128 | 2 | multiple of 2 | 1 | | |
| | 128 < blob <= 256 | 4 | multiple of 4 | 3 | | |
| | 256 < blob <= 512 | 8 | multiple of 8 | 7 | |
|
|
||
| For example, assume `SubtreeRootThreshold = 64`. This would mean that the blobs smaller than the `64` can start at an index that is a multiple of one and therefore introduce zero padding. Blobs that are larger than `64` but smaller than `64 * 2 = 128` can use an index that is a multiple of 2 to get a maximum of 1 padding share. Blobs that are larger than `64 * 2 = 128` but smaller than `64 * 4 = 256` can use an index that is a multiple of 4 to get a maximum of 3 padding shares and so on. | ||
|
|
||
| Blob size (in number of shares) | Subtree root width[^2] | Index in square | Worst case padding | ||
| --------------------------------|------------------------|-----------------|------------------- | ||
| blob <= 64 | 1 | multiple of 1 | 0 | ||
| 64 < blob <= 128 | 2 | multiple of 2 | 1 | ||
| 128 < blob <= 256 | 4 | multiple of 4 | 3 | ||
| 256 < blob <= 512 | 8 | multiple of 8 | 7 | ||
| | Blob size (in number of shares) | Subtree root width[^2] | Index in square | Worst case padding | | ||
| |---------------------------------|------------------------|-----------------|--------------------| | ||
| | blob <= 64 | 1 | multiple of 1 | 0 | | ||
| | 64 < blob <= 128 | 2 | multiple of 2 | 1 | | ||
| | 128 < blob <= 256 | 4 | multiple of 4 | 3 | | ||
| | 256 < blob <= 512 | 8 | multiple of 8 | 7 | | ||
|
|
||
| Note: the threshold doesn't need to be `64` and the implementation versions this constant so that it is possible to modify over time. | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [15-15]
Consider adding a comma before "but" when it connects two independent clauses, unless they are closely connected and short.
- This is a good improvement but we can reduce padding further.
+ This is a good improvement, but we can reduce padding further.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [17-17]
Use a hyphen in compound adjectives before nouns. Here, "worst-case padding" should be hyphenated.
- analyze the worst case padding for different blob sizes
+ analyze the worst-case padding for different blob sizes📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [23-23]
Add a comma after introductory phrases for clarity.
- In the naive approach if the block proposer aligned blobs one after another
+ In the naive approach, if the block proposer aligned blobs one after another📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [25-25]
Consider adding a comma before "but" when it connects two independent clauses.
- have the lowest ratio of data to padding but also have small blob inclusion proofs.
+ have the lowest ratio of data to padding, but also have small blob inclusion proofs.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [25-25]
Add a comma after introductory phrases for clarity.
- From now on this threshold is called the `SubtreeRootThreshold`
+ From now on, this threshold is called the `SubtreeRootThreshold`📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [35-35]
This sentence should start with an uppercase letter.
- where `blob` is the length of the blob in shares
+ Where `blob` is the length of the blob in shares📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [65-65]
Add a comma after introductory phrases for clarity.
- If light nodes can process this proof size without a problem then we can use this bound.
+ If light nodes can process this proof size without a problem, then we can use this bound.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [79-79]
Use a hyphen in compound adjectives before nouns. Here, "worst-case padding" should be hyphenated.
- In the current worst case a Celestia block is full of blobs of size 1
+ In the current worst-case a Celestia block is full of blobs of size 1📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [81-81]
Use a hyphen in compound adjectives before nouns. Here, "worst-case padding" should be hyphenated.
- ### Worst Case Padding
+ ### Worst-Case Padding
Maybe closes celestiaorg#2212 ## Motivation celestiaorg#3198 (comment)
Maybe closes #2212
Motivation
#3198 (comment)